<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GMimeReferences: GMime 3.0 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GMime 3.0 Reference Manual">
<link rel="up" href="core.html" title="Part III. GMime Core Reference">
<link rel="prev" href="gmime-gmime-utils.html" title="gmime-utils">
<link rel="next" href="gmime-GMimeFormatOptions.html" title="GMimeFormatOptions">
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#gmime-GMimeReferences.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="core.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gmime-gmime-utils.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gmime-GMimeFormatOptions.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gmime-GMimeReferences"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gmime-GMimeReferences.top_of_page"></a>GMimeReferences</span></h2>
<p>GMimeReferences — a list of Message-Ids</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gmime-GMimeReferences.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="returnvalue">GMimeReferences</span></a> *
</td>
<td class="function_name">
<a class="link" href="gmime-GMimeReferences.html#g-mime-references-new" title="g_mime_references_new ()">g_mime_references_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gmime-GMimeReferences.html#g-mime-references-free" title="g_mime_references_free ()">g_mime_references_free</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="returnvalue">GMimeReferences</span></a> *
</td>
<td class="function_name">
<a class="link" href="gmime-GMimeReferences.html#g-mime-references-copy" title="g_mime_references_copy ()">g_mime_references_copy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="returnvalue">GMimeReferences</span></a> *
</td>
<td class="function_name">
<a class="link" href="gmime-GMimeReferences.html#g-mime-references-parse" title="g_mime_references_parse ()">g_mime_references_parse</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="gmime-GMimeReferences.html#g-mime-references-length" title="g_mime_references_length ()">g_mime_references_length</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gmime-GMimeReferences.html#g-mime-references-append" title="g_mime_references_append ()">g_mime_references_append</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gmime-GMimeReferences.html#g-mime-references-clear" title="g_mime_references_clear ()">g_mime_references_clear</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="gmime-GMimeReferences.html#g-mime-references-get-message-id" title="g_mime_references_get_message_id ()">g_mime_references_get_message_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gmime-GMimeReferences.html#g-mime-references-set-message-id" title="g_mime_references_set_message_id ()">g_mime_references_set_message_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gmime-GMimeReferences.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences">GMimeReferences</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gmime-GMimeReferences.description"></a><h2>Description</h2>
<p>A list of Message-Ids as found in a References or In-Reply-To header.</p>
</div>
<div class="refsect1">
<a name="gmime-GMimeReferences.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="g-mime-references-new"></a><h3>g_mime_references_new ()</h3>
<pre class="programlisting"><a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="returnvalue">GMimeReferences</span></a> *
g_mime_references_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a>.</p>
<div class="refsect3">
<a name="g-mime-references-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-references-free"></a><h3>g_mime_references_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
g_mime_references_free (<em class="parameter"><code><a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> *refs</code></em>);</pre>
<p>Frees the <a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> list.</p>
<div class="refsect3">
<a name="g-mime-references-free.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>refs</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> list</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-references-copy"></a><h3>g_mime_references_copy ()</h3>
<pre class="programlisting"><a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="returnvalue">GMimeReferences</span></a> *
g_mime_references_copy (<em class="parameter"><code><a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> *refs</code></em>);</pre>
<p>Copies a <a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> list.</p>
<div class="refsect3">
<a name="g-mime-references-copy.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>refs</p></td>
<td class="parameter_description"><p>the list of references to copy</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-references-copy.returns"></a><h4>Returns</h4>
<p>a new <a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> list that contains
an identical list of items as <em class="parameter"><code>refs</code></em>
. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-references-parse"></a><h3>g_mime_references_parse ()</h3>
<pre class="programlisting"><a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="returnvalue">GMimeReferences</span></a> *
g_mime_references_parse (<em class="parameter"><code><a class="link" href="gmime-GMimeParserOptions.html#GMimeParserOptions" title="GMimeParserOptions"><span class="type">GMimeParserOptions</span></a> *options</code></em>,
                         <em class="parameter"><code>const <span class="type">char</span> *text</code></em>);</pre>
<p>Decodes a list of msg-ids as in the References and/or In-Reply-To
headers defined in rfc822.</p>
<div class="refsect3">
<a name="g-mime-references-parse.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>options</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimeParserOptions.html#GMimeParserOptions" title="GMimeParserOptions"><span class="type">GMimeParserOptions</span></a> or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/nullable"><span class="acronym">nullable</span></a>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>string containing a list of msg-ids</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-references-parse.returns"></a><h4>Returns</h4>
<p>a new <a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> containing the parsed message ids. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-references-length"></a><h3>g_mime_references_length ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
g_mime_references_length (<em class="parameter"><code><a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> *refs</code></em>);</pre>
<p>Gets the length of the <a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> list.</p>
<div class="refsect3">
<a name="g-mime-references-length.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>refs</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-references-length.returns"></a><h4>Returns</h4>
<p> the number of message ids in the list.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-references-append"></a><h3>g_mime_references_append ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
g_mime_references_append (<em class="parameter"><code><a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> *refs</code></em>,
                          <em class="parameter"><code>const <span class="type">char</span> *msgid</code></em>);</pre>
<p>Appends a reference to msgid to the list of references.</p>
<div class="refsect3">
<a name="g-mime-references-append.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>refs</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>msgid</p></td>
<td class="parameter_description"><p>a message-id string</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-references-clear"></a><h3>g_mime_references_clear ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
g_mime_references_clear (<em class="parameter"><code><a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> *refs</code></em>);</pre>
<p>Clears the <a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> list.</p>
<div class="refsect3">
<a name="g-mime-references-clear.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>refs</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-references-get-message-id"></a><h3>g_mime_references_get_message_id ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *
g_mime_references_get_message_id (<em class="parameter"><code><a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> *refs</code></em>,
                                  <em class="parameter"><code><span class="type">int</span> index</code></em>);</pre>
<p>Gets the specified Message-Id reference from the <a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a>.</p>
<div class="refsect3">
<a name="g-mime-references-get-message-id.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>refs</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>index</p></td>
<td class="parameter_description"><p>the index of the message id</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-references-get-message-id.returns"></a><h4>Returns</h4>
<p> the Message-Id reference from the <a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-references-set-message-id"></a><h3>g_mime_references_set_message_id ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
g_mime_references_set_message_id (<em class="parameter"><code><a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> *refs</code></em>,
                                  <em class="parameter"><code><span class="type">int</span> index</code></em>,
                                  <em class="parameter"><code>const <span class="type">char</span> *msgid</code></em>);</pre>
<p>Sets the specified Message-Id reference from the <a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a>.</p>
<div class="refsect3">
<a name="g-mime-references-set-message-id.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>refs</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimeReferences.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>index</p></td>
<td class="parameter_description"><p>the index of the message id</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>msgid</p></td>
<td class="parameter_description"><p>the message id</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="gmime-GMimeReferences.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GMimeReferences"></a><h3>struct GMimeReferences</h3>
<pre class="programlisting">struct GMimeReferences {
	GPtrArray *array;
};
</pre>
<p>A List of references, as per the References or In-Reply-To header
fields.</p>
<div class="refsect3">
<a name="GMimeReferences.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><span class="type">GPtrArray</span> *<em class="structfield"><code><a name="GMimeReferences.array"></a>array</code></em>;</p></td>
<td class="struct_member_description"><p>the array of message-id references</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>